fix: exclude release scratch dirs from RAT and license skill docs#4685
Merged
Conversation
The apache-rat-plugin runs during the verify phase on every install, including the six `mvnw ... install` runs in build-release-comet.sh. RAT walks the root module tree and the exclude list did not cover several untracked generated/scratch directories that accumulate during a release (Python virtualenv, docker workdir, extracted tarballs, rat report files, and the downloaded rat jar). Populated, these make each RAT pass slow and the build appears to hang. Add excludes for those paths to the Maven apache-rat-plugin config. The bash rat check (run-rat.sh) flagged files that the Maven check already skips. Reconcile the two: - Add the jni-bridge testdata backtrace/stacktrace fixtures (which moved from native/testdata) and .github/workflows/README.md to the bash rat exclude list. - Add the standard ASF license header to the five checked-in .claude/skills/*/SKILL.md files so they are properly licensed in the release tarball rather than excluded from the license check. The header is placed after the YAML frontmatter, which must stay first for the skill loader; RAT still detects it.
andygrove
force-pushed
the
fix-rat-release-scratch-dirs
branch
from
11ca1ad to
a53d513
Compare
andygrove
changed the title
comphead
reviewed
Jun 18, 2026
Co-authored-by: Oleks V <comphead@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Closes #4671.
Rationale for this change
The
apache-rat-pluginis bound to the Mavenverifyphase, so it runs on everyinstall, including the six./mvnw ... -DskipTests installruns indev/release/build-release-comet.sh(-DskipTestsskips tests, not RAT). RAT scans the root module's directory tree, and the exclude list did not cover several untracked generated/scratch directories that accumulate during a release (Python virtualenv, docker build workdir, extracted release tarballs, the rat report files, and the downloaded rat jar). Once populated, each RAT pass walks a very large number of files, so the build appears to hang rather than being busy.Separately, the bash rat check (
dev/release/run-rat.sh+rat_exclude_files.txt) flagged files that the Maven RAT config already skips, so the two checks were inconsistent.What changes are included in this PR?
apache-rat-pluginconfiguration inpom.xmlfor the release scratch paths:dev/release/venv/**,dev/release/comet-rm/workdir/**,dev/dist/**,dev/release/rat.txt,dev/release/filtered_rat.txt, anddev/release/*.jar.dev/release/rat_exclude_files.txt) with the Maven check by adding thenative/jni-bridge/testdata/backtrace/stacktrace fixtures (these moved fromnative/testdata, whose stale paths remain listed) and.github/workflows/README.md..claude/skills/*/SKILL.mdfiles. These ship in the release tarball (built viagit archive), so rather than excluding them from the license check they are now properly licensed like every other markdown file in the repo. The header is placed after the YAML frontmatter (which must remain the first content for the skill loader to parse it); RAT still detects the header in that position.How are these changes tested?
Built a release tarball from this branch the same way
dev/release/create-tarball.shdoes (git archive HEAD | gzip) and ran the realdev/release/run-rat.shagainst it, which reported "No unapproved licenses". Also confirmed with theapache-rat-0.16.1jar directly that a markdown file carrying the ASF header after YAML frontmatter is approved, while the same file without the header is not.